

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Resource Documents [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Document,Document Resource, RTF Generator (Enhanced),Resource Document,Resource Document RTF Generator (Enhanced),Resource Document RTF, Batch Generate Reports,Save,Save RTF Report As RTF Document (Enhanced),RTF Report,RTF Report Save As RTF Document (Enhanced),Rich Text Format Report,Rich Text Format Report Save As RTF Document (Enhanced),Generate,Generate RTF Document from Resources (Enhanced),Batch Generate,Batch Generate RTF Resource Documents, Manually,Batch Generate RTF Resource Documents, Automatically">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Resource Documents</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="import_rtf_template.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="rtfdocumentoptions.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_BodyText" style="font-style: italic;">Resource</span><span class="f_BodyText"> </span><span class="f_BodyText" style="font-style: italic;">Document</span><span class="f_BodyText"> feature enables a particular documentation configuration to be 'remembered', linking the loaded template within the </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_BodyText"> dialog to the current highlighted package. If a particular template is always used with a specific package, and multiple cases of documentation exist to be propagated, saving these as Resource Documents can ease document generation later.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">Resource Documents, saved into the </span><span class="f_UIControl">Resources</span><span class="f_TiporNoteText"> window, save only the package, output file destination and template name from the </span><span class="f_UIControl">Generate</span><span class="f_TiporNoteText"> tab of the </span><span class="f_UIControl"><a href="rtfdialogoptions.htm">Generate RTF Documentation</a></span><span class="f_TiporNoteText"> dialog. They do not retain the RTF data separately defined in the <a href="rtfdocumentoptions.htm">Options, Advanced</a> and <a href="rtf_element_filters.htm">Element Filter</a> </span><span class="f_TiporNoteText">tabs of the dialog</span><span class="f_TiporNoteText">.</span></p>
<p class="p_TiporNoteText"><span class="f_TiporNoteText">To save and re-use the options data, edit the template directly in the template editor and use the </span><span class="f_MenuKeyField"><a href="fileandprintoptions.htm">File | Document options</a></span><span class="f_TiporNoteText"> option to set the values as part of the template.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_BodyText">To create and use Resource Documents, follow the steps below:</span></p>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=1><span class="f_NumberedList">Open the <a href="createarichtextdocument.htm">Generate RTF Document dialog.</a></span></li>
<li value=2><span class="f_NumberedList">Click on the </span><span class="f_MenuKeyField">Resource Document</span><span class="f_NumberedList"> button. The </span><span class="f_UIControl">Save current as document definition</span><span class="f_NumberedList"> dialog displays:</span><br>
<span class="f_NumberedList">&nbsp;</span><br>
<img src="saveasdoc.png" width="272" height="70" border="0" alt="SaveAsDoc"><br>
<span class="f_NumberedList">&nbsp;</span></li>
<li value=3><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">Enter Value</span><span class="f_NumberedList"> field, type a name for the document and click on the </span><span class="f_MenuKeyField">OK</span><span class="f_NumberedList"> button. The document is added to the </span><span class="f_UIControl">Resources </span><span class="f_NumberedList">window for easy future access (as for the </span><span class="f_NumberedList" style="font-style: italic;">usecasedoc</span><span class="f_NumberedList"> entry in the illustration below).</span><br>
<span class="f_NumberedList">&nbsp;</span><br>
<img src="docresourceview.png" width="215" height="194" border="0" alt="DocResourceView"><br>
<span class="f_NumberedList">&nbsp;</span></li>
<li value=4><span class="f_NumberedList">To generate documentation from the </span><span class="f_UIControl">Resources</span><span class="f_NumberedList"> window, right-click on the required document. The context menu displays.</span></li>
<li value=5><span class="f_NumberedList">Select the required option.</span></li>
</ol>
<p class="p_BodyText"><span class="f_BodyText">The context menu options are:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_MenuKeyField">Open Document</span><span class="f_Bulletlist1"> - Opens the corresponding .RTF file, as specified by the RTF template </span><span class="f_Bulletlist1" style="font-style: italic;">Filename</span><span class="f_Bulletlist1"> property</span></li>
<li><span class="f_MenuKeyField">Generate Document</span><span class="f_Bulletlist1"> - Opens the </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_BodyText"> dialog</span><span class="f_Bulletlist1">, loaded with the specified template</span></li>
<li><span class="f_MenuKeyField">Auto Generate Document</span><span class="f_Bulletlist1"> - Generates documentation, with the document located at the path specified by the template's </span><span class="f_Bulletlist1" style="font-style: italic;">Filename</span><span class="f_Bulletlist1"> property</span></li>
<li><span class="f_MenuKeyField">Delete Document</span><span class="f_Bulletlist1"> - Removes the specified document.</span></li>
</ul>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Batch Generate Resource Documents</span></p>
<p class="p_BodyText"><span class="f_BodyText">To generate a number of RTF documents at the same time, right-click on the </span><span class="f_BodyText" style="font-style: italic;">RTF Documents</span><span class="f_BodyText"> folder name and select the </span><span class="f_MenuKeyField">Generate Documents</span><span class="f_BodyText"> context menu option. The </span><span class="f_UIControl">Batch Document Generation</span><span class="f_BodyText"> dialog displays.</span></p>
<p class="p_TextIndentedL2"><img src="batchdocgen.png" width="451" height="211" border="0" alt="BatchDocGen"></p>
<p class="p_BodyText"><span class="f_BodyText">The dialog lists all resource documents in the </span><span class="f_BodyText" style="font-style: italic;">RTF Documents</span><span class="f_BodyText"> folder. Deselect the checkbox against each document that you do not want to generate, then click on the </span><span class="f_MenuKeyField">OK</span><span class="f_BodyText"> button to generate each of the remaining reports into their respective target file locations.</span></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_MenuKeyField">Generate All Documents</span><span class="f_BodyText"> option automatically generates every document in the </span><span class="f_BodyText" style="font-style: italic;">RTF Documents</span><span class="f_BodyText"> folder, without displaying the </span><span class="f_UIControl">Batch Document Generation</span><span class="f_BodyText"> dialog.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
